home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / btrieve / butnlm.exe / BUTNLM.TXT < prev   
Text File  |  1993-09-17  |  5KB  |  157 lines
  1.  
  2.               NOVELL TECHNICAL INFORMATION DOCUMENT
  3.  
  4. TITLE:              Butil NLM version 5.15a
  5. DOCUMENT ID:        TID000067
  6. DOCUMENT REVISION:  A
  7. DATE:               01JUL93
  8. ALERT STATUS:       Yellow
  9. INFORMATION TYPE:   Symptom Solution
  10. README FOR:         BUTNLM.EXE
  11.  
  12. NOVELL PRODUCT and VERSION:
  13. NetWare Btrieve NLM 5.15
  14.  
  15. ABSTRACT:
  16. This file contains BUTIL.NLM v5.15a for use with NetWare's BTRIEVE.NLM. The
  17. BUTIL NLM is a utility that performs most functions of the DOS BUTIL.EXE
  18. _________________________________________________________________
  19.  
  20. DISCLAIMER
  21. THE ORIGIN OF THIS INFORMATION MAY BE INTERNAL OR EXTERNAL TO NOVELL. 
  22. NOVELL MAKES EVERY EFFORT WITHIN ITS MEANS TO VERIFY THIS INFORMATION. 
  23. HOWEVER, THE INFORMATION PROVIDED IN THIS DOCUMENT IS FOR YOUR INFORMATION
  24. ONLY.  NOVELL MAKES NO EXPLICIT OR IMPLIED CLAIMS TO THE VALIDITY OF THIS
  25. INFORMATION.
  26. _________________________________________________________________
  27.  
  28. Self-Extracting File Name:  BUTNLM.EXE
  29.  
  30. Files Included     Size     Date        Time
  31.  
  32.   BUTNLM.TXT          (This File)
  33.    BUTIL.NLM      64489    7-09-91     10:10a
  34.  
  35.  
  36.                 README FOR BTRIEVE's BUTIL (NLM) v5.15a RELEASE
  37.  
  38. This README file of BUTNLM.EXE accompanies the released version of BUTIL
  39. NLM v5.15a.  The following files are included:
  40.  
  41.  
  42. ** May 9, 1991 **
  43.  
  44. Version 5.15a
  45.  
  46. BUTIL.NLM is a utility which contains a set of commands that allow Btrieve
  47. users to create, maintain and recover Btrieve files at the server. 
  48. BUTIL.NLM supports 10 of the commands that are implemented in BUTIL.EXE. 
  49. The following is a list of commands that are available and a short
  50. description of each:
  51.  
  52. * Clone
  53. command format: Load Butil -Clone <New File> <Existing File> [-o<Owner>]
  54.  
  55. The Clone command creates a new, empty Btrieve file with the same file
  56. structure as an existing file.
  57.  
  58. * Copy
  59. command format: Load Butil -Copy  <Input File> <Output File> [-o<OwnerIn>  
  60.                  [ -O <OwnerOut>]]
  61.  
  62. The Copy command copies the contents of one Btrieve file to another.
  63.  
  64. * Create
  65. command format: Load Butil -Create <New File> <Description File>
  66.  
  67. The Create command builds an empty Btrieve file using the structure
  68. specified in a description file.
  69.  
  70. * Drop
  71. command format: Load Butil -Drop <Btrieve File> <Key Number> [-o<Owner>]
  72.  
  73. The Drop command is used to remove a supplemental index from a Btrieve
  74. file.
  75.  
  76. * Index
  77. command format: Load Butil -Index <Btrieve File> <Index File> <Description
  78. File> [-o<Owner>]
  79.  
  80. The Index command builds an external index file based on a field that had
  81. not been specified as a key before.
  82.  
  83. * Load
  84. command format: Load Butil -Load <Input File> <Btrieve File> [-o<Owner>]
  85.  
  86. The Load command allows you to insert records from a sequential file into a
  87. Btrieve file.
  88.  
  89. * Recover
  90. command format: Load Butil -Recover <Btrieve File> <Output File>
  91. [-o<Owner>]
  92.  
  93. The Recover command reads records from a Btrieve file and writes them to a
  94. sequential file that is compatible with the Load command.
  95.  
  96. * Save
  97. command format: Load Butil -Save <Btrieve File> <Output File> [<Y|N> <Index
  98. File> | <Key Number>] [-o<Owner>]
  99.  
  100. The Save command allows you to retrieve records from a Btrieve file by a
  101. specified index path, and creates a sequential file that is compatible with
  102. the Load command.
  103.  
  104. * Sindex
  105. command format: Load Butil -Sindex <Btrieve File> <Description File>
  106. [-o<Owner>]
  107.  
  108. The Sindex command creates a supplemental index for an existing Btrieve
  109. file.
  110.  
  111. * Stat
  112. command format: Load Butil -Stat <Btrieve File> [-o<Owner>]
  113.  
  114. The Stat command returns characteristics and statistics about a Btrieve
  115. file.
  116.  
  117. The command line:
  118.     Load Butil -Command Parameters
  119.  
  120. loads the NLM, executes the operation specified and unloads the NLM.  You
  121. can either execute these commands from the console prompt, or enter them
  122. into a NetWare Command File(NCF).
  123.  
  124. It is important to specify the complete path, including the volume name on
  125. the command line or in the NCF file.  BUTIL.NLM will return non-zero status
  126. (unsuccessful operation), when a complete path is not specified.
  127.  
  128. For example, the following command will create a file called MyFile.Btr in
  129. the Sys: volume under the Test subdirectory using description file
  130. MyFile.des:
  131.  
  132.   Load Butil -create Sys:\Test\MyFile.btr Sys:\Test\MyFile.des
  133.  
  134. If a NCF file is used to execute BUTIL operations, the file can only
  135. contain one BUTIL command.  In other words, to recover a damaged Btrieve
  136. file using Recover and Load commands, you need to have two NCF files; one
  137. for the Recover command and one for the Load command.  This is because the
  138. first operation loads the NLM and executes the command.  Meanwhile, the
  139. second BUTIL operation tries to load the NLM while the first one is still
  140. running.
  141.  
  142. In this case, the second attempt to load the BUTIL NLM will result with the
  143. error "This module is already loaded and cannot be loaded more than once".
  144.  
  145. There is no advantage for running BUTIL.NLM compared to BUTIL.EXE in many
  146. cases, such as Create, Stat and Drop.  It might even be more convenient to
  147. run BUTIL at the workstation for most of the operations.  However, it is
  148. much faster to recover files using the NLM version.
  149.  
  150. The BUTIL.NLM runs under the following combinations:
  151.  
  152.     1.   Netware version 3.10 with Btrieve version 5.10.
  153.     2.   Netware version 3.10 with Btrieve version 5.15.
  154.     3.   Netware version 3.11 with Btrieve version 5.15.
  155.  
  156.  
  157.